﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-CN" lang="zh-CN">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="zh-CN" />
<title>JSDOC</title>
<style type="text/css">
body *{
	font-size:12px;	font-family: Verdana, Tahoma, "Lucida Grande", "Lucida Sans", Arial, "Trebuchet MS", Sans-Serif, Georgia, Courier, Serif;
}
h2{
  font-size: 24px;
  text-align: center;
  color: #00008B;
  font-weight: bolder;
}
body{
  padding-top: 30px;
}
p{
  font-size: 14px;
  text-indent: 2em;
}
li{
  font-size: 14px;
}
.access{
  color: #00008B;
  font-weight: bolder;
}
#footer{
  margin: 20px;
  margin-top: 100px;
  padding:10px;
  border: 1px dotted blue;
  background-color: #FFFFAA;
}
</style>
</head>
<body>
<h2>JavaScript Integration API Document Tool.</h2>
<p>该程序可以通过指定若干自由脚本和JSI的脚本包路径。自动生成对应的JavaScript API文档。</p>
<p>该工具自JSI1A6开始使用，但是JSI2对依赖管理部分改动很大,目前对于JSI2来说，依赖的文档尚不可用，大家将就着用吧，对于API和源代码查阅还是挺方便的。</p>
<h1>JSDoc简介</h1>
<p>JSDoc是在JSI上开发的脚本API实时解析程序（JSDoc） 可以简化文档写作及API查阅。 基于xml template 开发的文档工具，实时解析。 无需安装任何软件，纯html/js应用程序。</p>
<div>
<h3>脚本分类</h3>
<ul>
  <li><span class='access'>自由脚本</span>: 通过页面的script标签引入、在全局上下文执行的脚本</li>
  <li><span class='access'>托管脚本</span>: 存在JSI包描述的，可以通过JSI的$import函数导入、在特定装载单元执行的脚本</li>
</ul>
</div>
<div>
<h3>JSDoc 访问修饰的解释</h3>
<ul>
  <li><span class='access'>public</span>: 公开元素，任何地方可以使用该元素</li>
  <li><span class='access'>friend</span>: 友元元素，可以在任何地方使用， 但是使用它意味着，你和这个类库紧密的关系，可以看成一种高级功能</li>
  <li><span class='access'>protected</span>: 保护元素，只能是继承它的子类调用（javascript原型继承）</li>
  <li><span class='access'>intenal</span>: 内部元素，只能在这个类库内部使用，不建议第三方访问的元素</li>
  <li><span class='access'>private</span>: 私有元素，装载单元（文件）内部使用</li>
</ul>
</div>
<div id='footer'>
页面通过客户端XML模板引擎自动生成(org/xidea/xml/template.js)。
该模板引擎实现简单，但一直没有做优化工作，效率不高；所以JSDoc对于大文件的源码高亮显示有点慢。
如果您对这种实时解析的脚本API文档工具感兴趣，欢迎参与开发、完善，或者认领(管理)这个项目。
</div>
</body>
</html>